Spring Cloud Gateway 笔记补充

作者： 李多多 日期： 2020-08-14
Spring Cloud
Spring Cloud Gateway 笔记补充

@[TOC](Spring Cloud Gateway)

1. 简介

SpringCloud Gateway 旨在为微服务架构提供一种简单有效的统一的 API 路由管理方式。
SpringCloud Gateway 作为 Spring Cloud 生态系统中的网关，目标是替代 Zuul，使用的是Spring Boot和Spring Webflux提供的Netty底层环境，不能和传统的Servlet容器一起使用，也不能打包成一个WAR包。

SpringCloud官 对SpringCloud Gateway 特征介绍如下：

（1）基于 Spring Framework 5，Project Reactor 和 Spring Boot 2.0

（2）集成 Hystrix 断路器

（3）集成 Spring Cloud DiscoveryClient

（4）Predicates 和 Filters 作用于特定路由，易于编写的 Predicates 和 Filters

（5）具备一些网关的高级功能：动态路由、限流、路径重写

从以上的特征来说，和Zuul的特征差别不大。SpringCloud Gateway和Zuul主要的区别，还是在底层的通信框架上。

简单说明一下上文中的三个术语：

（1）Filter（过滤器）：

和Zuul的过滤器在概念上类似，可以使用它拦截和修改请求，并且对上游的响应，进行二次处理。过滤器为org.springframework.cloud.gateway.filter.GatewayFilter类的实例。

（2）Route（路由）：

网关配置的基本组成模块，和Zuul的路由配置模块类似。一个Route模块由一个 ID，一个目标 URI，一组断言和一组过滤器定义。如果断言为真，则路由匹配，目标URI会被访问。

（3）Predicate（断言）：

这是一个 Java 8 的 Predicate，可以使用它来匹配来自 HTTP 请求的任何内容，例如 headers 或参数。断言的输入类型是一个 ServerWebExchange。

2. 基本用法

SpringCloud Gateway 支持两种不同的用法：

  • 编码式
  • yml 配置

2.1 首先来看编码式：

创建 Spring Boot 项目，添加依赖：
在这里插入图片描述
项目创建成功后，直接配置一个 RouteLocator 这样一个Bean,就可以实现请求转发。

@Bean
  RouteLocator routeLocator(RouteLocatorBuilder builder){
      // 可以添加多个
      return builder.routes()
              // 访问网址 http://httpbin.org
              // 通过网关后访问 http://localhost:8080/get
              .route("javaboy", r -> r.path("/get").uri("http://httpbin.org"))
              .build();
  }

这里只需提供 RouteLocator 的Bean 就可实现请求转发，配置完成后，访问 http://localhost:8080/get 就会转发至 http://httpbin.org 接口。

2.2 yml 配置

注释掉上面的Bean ，配置如下yml，重启服务与源来效果相同。

spring:
  cloud:
    gateway:
      routes:
        - id: java
          uri: http://httpbin.org
          predicates:
            - Path=/get

2.3 与微服务结合

还是延用以前的eurek server和provider以及gateway。首先给 gateway 添加依赖：

<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
</dependency>

在这里插入图片描述
然后配置yml ：

spring:
  cloud:
    gateway:
      discovery:
        locator:
          # 开启自动代理
          enabled: true
          # 服务id为true --> 这样小写服务就可访问了
          lower-case-service-id: true
  application:
    name: gateway

eureka:
  client:
    service-url：
      defaultZone: http://localhost:1111/eureka

#日志
logging:
  level:
    org.springframework.cloud.gateway: debug

接下来启动eurek server和provider以及gateway，就可以通过gateway (http://localhost:8080/provider/hello)
访问到其他注册到Erueka上的服务了。访问方式和Zuul 类似。
小结：gateway 注册到 eureka ，就可以自动代理注册中心的所有服务，简化路由配置的使用方式。

3. Predicate(断言)

3.1 时间断言

  • Before –> 请求时间在某个时间点之前 才会被路由
  • After –> 请求时间在某个时间点之后 才会被路由
  • Between –> 请求时间在2个时间点之间(两个时间点,分开)
spring:
  cloud:
    gateway:
      routes:
        - id: before_route
          uri: http://www.baidu.com
              # 时间断言
          predicates:
              - Before=2021-03-31T08:38:47+08:00

访问： localhost:8080 如下：
在这里插入图片描述

如果改为 - Before=2020-03-31T08:38:47+08:00 重启访问后如下：

在这里插入图片描述

3.2 请求方法&请求路径断言

spring:
  cloud:
    gateway:
      routes:
        - id: java_route
          uri: http://httpbin.org
          predicates:
               - Method=GET

上面这个配置表示只给 GET请求路由，访问 http://localhost:8080/get 就成功。

spring:
  cloud:
    gateway:
      routes:
        - id: java_route
          uri: http://httpbin.org
          predicates:
              - Path=/2020/0912/{segment}

上面这个配置表示路径满足这个规则都会进行转发，例如：http://www.xxx.com/2020/0912/** ，否则不转发。

3.3 Query 断言

spring:
  cloud:
    gateway:
      routes:
        - id: java_route
          uri: http://httpbin.org
          predicates:
               - Query=name

上面配置表示一定要有 name 参数才转发，否则不会转发。
也可以指定参数的值，例如参数的 key 为 name ，value 必须要以 java 开始。 如下：

spring:
  cloud:
    gateway:
      routes:
        - id: java_route
          uri: http://httpbin.org
          predicates:
               - Query=name,java.*

3.4 多种匹配方式

spring:
  cloud:
    gateway:
      routes:
        # 组合使用
        - id: many_route
          uri: http://httpbin.org
          predicates:
            # 可以指定参数和值 ?name=1开头的值
            - Query=name,1.*
            - Method=GET
            - After=2020-03-01T08:38:47+08:00

满足以上条件即可转发。

3.5 自定义路由断言

配置自定义断言工厂：

// 自定义路由断言工厂
// 命名需要以RoutePredicateFactory结尾 比aRoutePredicateFactory 那么yml在使用时a就是断言工厂的名字
@Component
public class CheckAuthRoutePredicateFactory extends AbstractRoutePredicateFactory<CheckAuthRoutePredicateFactory.User> {
 
    public CheckAuthRoutePredicateFactory() {
        super(User.class);
    }
 
    // 自定义配置类
    @Override
    public Predicate<ServerWebExchange> apply(User config) {
        return exchange -> {
            System.out.println("进入apply：" + config.getName());
            if (config.getName().equals("kitty")){
                return true;
            }
            return false;
        };
    }
 
    public static class User{
        private String name;
 
        public String getName() {
            return name;
        }
 
        public void setName(String name) {
            this.name = name;
        }
    }
}

yml 配置：

spring:
  cloud:
    gateway:
      routes:
        # 自定义断言工厂 -name就是之前以xxxRoutePredicateFactory的xxxx为断言工厂名
        - id: customer_route
          uri: http://httpbin.org
          predicates:
          - name: CheckAuth
            args:
              name: kitty

当参数name=kitty与自定义断言工厂的getName一致时：

在这里插入图片描述

当参数name=kitty与自定义断言工厂的getName不一致时

在这里插入图片描述

4. Filter（过滤器）

gateway过滤器分类：

  • GlobalFilter
  • GatewayFilter

    这里的过滤器就是在请求转发的时候，自动额外添加参数。

    4.1 AddRequestParameter过滤器使用

spring:
  cloud:
    gateway:
      routes:
        - id: java_route
          uri: lb://provider
          filters:
            - AddRequestParameter=name,javaboy
          predicates:
              - Method=GET

在这里插入图片描述

FEATURED TAGS
Spring Cloud
FRIENDS